
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>Preface</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>Preface</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="title.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="manvol1.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="GSRFM441"></a><a id="sthref2"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="preface">Preface</h2>
<div class="sectionbody">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph">
<p>This documentation is part of the Java Enterprise Edition contribution
to the Eclipse Foundation and is not intended for use in relation to
Java Enterprise Edition or Orace GlassFish. The documentation is in the
process of being revised to reflect the new Jakarta EE branding.
Additional changes will be made as requirements and procedures evolve
for Jakarta EE. Where applicable, references to Java EE or Java
Enterprise Edition should be considered references to Jakarta EE.</p>
</div>
<div class="paragraph">
<p>Please see the Title page for additional license information.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Both novice users and those familiar with Payara Server Open Source
Edition can use online man pages to obtain information about the product
and its features. A man page is intended to answer concisely the
question "What does it do?" The man pages in general comprise a
reference manual. They are not intended to be a tutorial.</p>
</div>
<div class="paragraph">
<p><a id="GSRFM442"></a><a id="sthref3"></a></p>
</div>
<div class="sect2">
<h3 id="overview">Overview</h3>
<div class="paragraph">
<p>The following contains a brief description of each man page section and
the information it references:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Section 1 describes, in alphabetical order, the <code>asadmin</code> utility
subcommands.</p>
</li>
<li>
<p>Section 1M describes Payara Server utility commands.</p>
</li>
<li>
<p>Section 5ASC describes concepts that are related to Payara Server<br>
administration.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Below is a generic format for man pages. The man pages of each manual
section generally follow this order, but include only needed headings.
For example, if there are no bugs to report, there is no Bugs section.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Name</dt>
<dd>
<p>This section gives the names of the commands or functions documented,
followed by a brief description of what they do.</p>
</dd>
<dt class="hdlist1">Synopsis</dt>
<dd>
<p>This section shows the syntax of commands or functions.<br>
The following special characters are used in this section:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1">[ ]</dt>
<dd>
<p>Brackets. The option or argument enclosed in these brackets is
optional. If the brackets are omitted, the argument must be
specified.</p>
</dd>
<dt class="hdlist1">|</dt>
<dd>
<p>Separator. Only one of the arguments separated by this character can
be specified at a time.</p>
</dd>
</dl>
</div>
</dd>
<dt class="hdlist1">Description</dt>
<dd>
<p>This section defines the functionality and behavior of the service.
Thus it describes concisely what the command does. It does not discuss
options or cite examples.</p>
</dd>
<dt class="hdlist1">Options</dt>
<dd>
<p>This section lists the command options with a concise summary of what
each option does. The options are listed literally and in the order
they appear in the Synopsis section. Possible arguments to options are
discussed under the option, and where appropriate, default values are
supplied.</p>
</dd>
<dt class="hdlist1">Operands</dt>
<dd>
<p>This section lists the command operands and describes how they affect
the actions of the command.</p>
</dd>
<dt class="hdlist1">Examples</dt>
<dd>
<p>This section provides examples of usage or of how to use a command or
function. Wherever possible a complete example including command-line
entry and machine response is shown. Examples are followed by
explanations, variable substitution rules, or returned values. Most
examples illustrate concepts from the Synopsis, Description, Options,
and Usage sections.</p>
</dd>
<dt class="hdlist1">Exit Status</dt>
<dd>
<p>This section lists the values the command returns to the calling
program or shell and the conditions that cause these values to be
returned. Usually, zero is returned for successful completion, and
values other than zero for various error conditions.</p>
</dd>
<dt class="hdlist1">See Also</dt>
<dd>
<p>This section lists references to other man pages, in-house
documentation, and outside publications.</p>
</dd>
<dt class="hdlist1">Notes</dt>
<dd>
<p>This section lists additional information that does not belong
anywhere else on the page. It takes the form of an aside to the user,
covering points of special interest. Critical information is never
covered here.</p>
</dd>
<dt class="hdlist1">Bugs</dt>
<dd>
<p>This section describes known bugs and, wherever possible, suggests
workarounds.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="title.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="manvol1.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
